home *** CD-ROM | disk | FTP | other *** search
/ Aminet 12 / Aminet 12 (1996)(GTI - Schatztruhe)[!][Jun 1996].iso / Aminet / disk / cdrom / cdindexb2.readme < prev    next >
Encoding:
Text File  |  1996-05-05  |  6.9 KB  |  236 lines
  1. Short:    Search CeeD's & Co Disks database
  2. Author:   1schuppe@informatik.uni-hamburg.de
  3. Uploader: 1schuppe@informatik.uni-hamburg.de
  4. Type:     disk/cdrom
  5.  
  6. Welcome to CDIndex!
  7.  
  8. This is release ß2 (see history for changes). Search for (new) to
  9. see changes in this documentation.
  10.  
  11. If you use CDDA player programs such as CeeD (by Peter Urbanec)
  12. and create a database of your CDs, this is the program for you!
  13. CDIndex allows you to search in such databases; just enter the pattern
  14. and press return.
  15.  
  16.  
  17. Contents:
  18. -------------------------------------------------------------------------
  19. 0. Installation
  20. 1. Graphical Interface
  21. 2. Keyboard Accelerators
  22. 3. Message Line
  23. 4. About the Search Algorithm
  24. 5. Program Information
  25. 6. Future Versions
  26.  
  27. A. About The Database Included in this Distribution
  28. B. Authors Address
  29. C. History (new)
  30.  
  31.  
  32. 0. Installation
  33. --------------------------------------------------------------------------
  34.  
  35. Just copy CDIndex (and it's icon) to your favourite directory. Click on
  36. the icon and set the tooltypes:
  37.  
  38.     DISKSPATH   Specify the directory where CDIndex will find the
  39.                 index files of your CDs. Don't forget a "/" at the end
  40.                 of the path.
  41.                 (default EH0:PublicDomain/Disk/CeeD/Disks/)
  42.  
  43.     WINX        Position of the top left corner of CDIndex's
  44.     WINY        window. (default 0)
  45.  
  46.     TITLEPOINTS         Points, if pattern was found in the title (10)
  47.     ARTISTPOINTS        Points, if pattern was found in the artist line (10)
  48.     FULLWORDPOINTS      Points, if pattern is a complete word (5)
  49.     MATCHONLYPOINTS     Points, if pattern was found inside a word (1)
  50.  
  51.  
  52.  
  53. 1. Graphical Interface
  54. --------------------------------------------------------------------------
  55.  
  56. Artist          Artist of current displayed CD
  57.  
  58. Title           Title of current displayed CD
  59.  
  60. (Listview)      All tracks of the current CD are displayed here
  61.  
  62. Pattern         Enter your seach pattern in this string gadget
  63.  
  64. (Cycle)         Allows you to modify the search area. The possible
  65.                 values are:
  66.  
  67.                 Anywhere        Searches in artist, title and track
  68.                                 listing.
  69.                 Artist          Searches only in the artist line¹.
  70.                 Title           Searches only in the title line¹.
  71.                 Track listing   Searches only in the track listing¹.
  72.  
  73. Start Search    Press this button to start search.
  74.  
  75. <               View previous entry (if available).
  76.  
  77. >               View next entry (if available).
  78.  
  79.  
  80.  
  81. 2. Keyboard Accelerators
  82. --------------------------------------------------------------------------
  83.  
  84. Instead of using the mouse, you can also activate every function with
  85. your keyboard.
  86.  
  87. a           Copy artist into the string gadget.
  88.  
  89. c (C)       Next (previous) value of the cycle gadget (search area).
  90.  
  91. p           Activate string gadget for text entry.
  92.  
  93. q or x      Quit CDIndex
  94.  
  95. s           Start search.
  96.  
  97. t           Copy title into the string gadget.
  98.  
  99. <           View previous entry (if available).
  100.  
  101. >           View next entry (if available).
  102.  
  103.  
  104.  
  105. 3. Message Line
  106. --------------------------------------------------------------------------
  107.  
  108. The message line shows your information of CDIndex's status or gives
  109. you information of the search results of the current displayed CD.
  110.  
  111.  
  112.  
  113. 4. About the Search Algorithm
  114. --------------------------------------------------------------------------
  115.  
  116. The search algortim is based on the algorithm of Booyer and Moore and
  117. gives different points the following reasons (you could change the
  118. values with the tooltypes, see above):
  119.  
  120.     10  points if the pattern was found in the artist line
  121.     10  points if the pattern was found in the title line
  122.      5  points if the pattern is a whole word
  123.      1  point if the pattern was found anywhere else
  124.  
  125. Example:
  126.  
  127.     You search for the pattern "Love" in your database which contains
  128.     only this CD:
  129.  
  130.     Artist: Software
  131.     Title : I Love To Love
  132.  
  133.     Track #1: I Love To Love
  134.     Track #2: I'm Your Loverboy
  135.     Track #3: Science Can't Be Crime
  136.     Track #4: Last Track
  137.  
  138.     Than this CD reaches 41 points:
  139.  
  140.     15 points for the first "Love" in the title
  141.     15 points for the second one.
  142.      5 points for the first "Love" in track #1.
  143.      5 points for the second one.
  144.      1 point for "Love" in "Loverboy"
  145.     --
  146.     41 points
  147.  
  148.     If this was the highest rating, it is set to 100%.
  149.  
  150.     Notice: The search is case sensitive if you have upper case
  151.     letters in your pattern; it's case insensitive if you enter
  152.     only lower case letters (This feature was already implemented
  153.     in the first release, but not mentioned here). (new)
  154.  
  155. 5. Program Information
  156. --------------------------------------------------------------------------
  157.  
  158. This program is a beta release, which means
  159.  
  160.     · not fontsensitive (it uses topaz 8)
  161.     · not checked for enforcer hits (I have only a 68000)
  162.     · not guarrented to work correctly
  163.     · ...
  164.  
  165. CDIndex is Public Domain (whatever this means...).
  166.  
  167.  
  168.  
  169. 6. Future Versions
  170. --------------------------------------------------------------------------
  171.  
  172. Hmm, maybe. Yes, this one! (new)
  173.  
  174.  
  175.  
  176. A. About The Database Included in this Distribution
  177. --------------------------------------------------------------------------
  178.  
  179. The file mydisks.lha includes some of my audio CDs. You could use it
  180. to test CDIndex, use for your own or delete it...
  181. If you want a complete catalogue of all my CDs, send me an e-mail (see
  182. address below).
  183.  
  184.  
  185.  
  186. B. Authors Address
  187. --------------------------------------------------------------------------
  188.  
  189.     Fin Schuppenhauer
  190.     Braußpark 10
  191.     D-20537 Hamburg
  192.     (Germany)
  193.  
  194.     E-Mail: 1schuppe@informatik.uni-hamburg.de
  195.  
  196.  
  197.  
  198. C. History (new)
  199. --------------------------------------------------------------------------
  200.  
  201. ß1                  · Initial release.
  202.  
  203. ß2 (29.03.1996)     · CDInxex crased, if you have index files bigger
  204.                       than 1024 bytes. Now increased to 16834 bytes.
  205.                     · Artist and title search was mixed up
  206.  
  207.  
  208.  
  209. ¹
  210. Format of CeeD's & Co. index file. Each CD is represented as an own
  211. file, the filename is the CD ID, for example "ID1440322D041741". The
  212. data is readable ascii of the follwing form:
  213.  
  214. First line  : Artist
  215. Second line : Title
  216. Third line  : Track #1
  217. Fourth line : Track #2
  218. ...           ...
  219. line n+2    : Track n
  220.  
  221.  
  222. ============================= Archive contents =============================
  223.  
  224. Original  Packed Ratio    Date     Time    Name
  225. -------- ------- ----- --------- --------  -------------
  226.    16804    9324 44.5% 08-Mar-96 12:59:48 +CDIndex
  227.      969     443 54.2% 26-Feb-96 23:33:14 +CDIndex.info
  228.     6321    2307 63.5% 29-Mar-96 09:24:10 +CDIndexb2.readme
  229.       16      16  0.0% 24-Feb-96 10:09:12 +m2c.opt
  230.       14      14  0.0% 25-Feb-96 11:49:06 +m2l.opt
  231.    23556   23556  0.0% 26-Feb-96 23:44:46 +mydisks.lha
  232.    37958    8270 78.2% 08-Mar-96 12:50:18 +CDIndex.mod
  233.      628     260 58.5% 29-Mar-96 09:11:00  CDIndexb2.info
  234. -------- ------- ----- --------- --------
  235.    86266   44190 48.7% 30-Mar-96 11:04:52   8 files
  236.